Get Assessment Form Result
Introduction
An assessment form result can be retrieved by using the Assetic REST API endpoint:
- GET /api/v2/assessmentformresult/{id}
- Gets the full detail of a specific Assessment Form Result By Form Result GUID
Form Result GUIDs for any form definition can be retrieved from Advanced Search, by adding the 'Form Result Guid' field to an Advanced Search's fields list. Please see the Advanced Search article for more details.
GET /api/v2/assessmentformresult/{id}
The Assetic REST API GET /api/v2/assessmentformresult/{id} returns a response containing the details for a specified Assessment Form Result, where 'Id' is the form result's GUID, with the following response fields:
| Property | Description |
| Id | Unique system-generated identifier for the Assessment Form Result |
| FormId | Unique system-generated identifier of the parent assessment form that the returned form result has been applied against. |
| FormName | Reference name of the parent assessment form |
| FormLabel | User-friendly name of the parent assessment form |
| FormVersion | A version number of the form. Integer value. |
| FormApplicableLevel |
The Assetic module/level the form definition is designed for: 2="Asset", 7="Work Order" |
| FormResultStartTime | DateTime that the assessor started using a form for the Assessment Form Result |
| FormResultEndTime | DateTime that the assessor finished using a form for the Assessment Form Result |
| FormResultLastModified | DateTime that the Assessment Form Result was last modified |
| FormResultStatus |
Current status of the Assessment Form Result: 0="Active", 100="Inactive" |
| FormResultComment | Text field containing general comments in regards to the Assessment Form Result |
| FormResultSkipped | An indicator if the assessor skipped the assessment. Boolean true or false |
| FormResultSkippedReason | Text field containing reason comment if the Assessment Form Result was skipped |
| FormResultRsResourceIdAssessedBy | An object containing the details of the resource who carried out the assessment. Contains the 'GUID' and the 'Display Name' of the resource |
| FormResultAspNetUserCreatedBy | Unique system-generated identifier for user account linked to the resource that created the Assessment Form Result |
| FormResultIsRequiredBySystem | An indicator if the Assessment Form Result is required. Boolean true or false |
| FormResultASMTFormVersionId | Unique system-generated identifier of the parent assessment form's version Id. |
| Data |
An object containing the assessment data, for all controls defined in the parent assessment form definition. Data within the object is returned in key-value pairs, where the assessment form control name is the key and the value is the data supplied by the assessor. Additional information about a specific form's controls can be obtained by retrieving its definition, as described in the article Get Assessment Forms |
| ParentEntityId | Unique system-generated identifier for the Assessment Task that the form result has been applied against. |
Sample Response
The following is a sample response body for the GET request.
{
"Data": [
{
"Id": "2e0a2c4c-3552-4ec2-ac81-78ce302522a8",
"FormId": "2f831710-eb71-4b6c-b8ae-8409de4d6b09",
"FormName": "FOOTPATHDEFECTS",
"FormLabel": "Footpath Defects",
"FormVersion": 1,
"FormApplicableLevel": 2,
"FormResultStartTime": "2022-10-01T12:10:52",
"FormResultEndTime": "2022-10-08T17:10:52",
"FormResultLastModified": "2022-10-08T17:10:52",
"FormResultStatus": 0,
"FormResultComment": "Assessment finalised.",
"FormResultSkipped": false,
"FormResultSkippedReason": 0,
"FormResultRsResourceIdAssessedBy": {
"Id": "b3a541ae-b3b9-4f9c-bccb-648470f8fde9",
"DisplayName": "Roger Federer",
"_links": [],
"_embedded": null
},
"FormResultAspNetUserCreatedBy": "b3a541ae-b3b9-4f9c-bccb-648470f8fde9",
"FormResultIsRequiredBySystem": false,
"FormResultASMTFormVersionId": "f149e3e8-f70c-4a5d-b944-de0956759e06",
"Data": {
"C17f912ae80cb46099f2cb2c6a18e877c": "2022-10-01T00:00:00",
"Ca823b48f0d024966ac716ad9eb2c8433": "L",
"C513390a4b3a641c99d3131f0ac896b53": "234",
"Cd079e30918584687bbf374a12a796981": "Henry",
"C7b7d9419c8084e91a6b876843c75791e": "Melbourne",
"Cbffb95da115a4afbb05b68243b4668b3": "Diana",
"Ce186ab7b8c1743f3aa9111664a8ce3c9": "4 - High",
"C6e767148770149279dd9589ddfed49f7": "4 - High",
"C423a1e7db27f4dbb927cab6404dfff1a": "3 - Moderate",
"C0e9c8356f408417faa160abbcd961be0": "5 - Extreme",
"Cf9160b880f164f56a3ce415db6e5549c": "3 - Moderate",
"Ca6b4c5e04b9a4f8cac2577a08bfc62a7": "4 - High",
"C7b4603783cde424f936cf44e0f76acd4": "3",
"C13b9dc7bc11240919f8e88365f31fe39": "10.0",
"Ce4ef64c0cc2f452f9ed802f31313536c": "2.0",
"C392c8cc0ed6e4682b579e6f6f9864ea1": "High",
"Cb5a16753172b4889b9e78350ed61142f": "",
"C0939535994494656828821de15bf371b": "Asphalt",
"mapLocationPoint": "POINT (144.970222860575 -37.8200599818821)",
"mapLocationComment": "8 Boathouse Dr, Melbourne VIC 3004, Australia",
"C0b3a742b88ba4661ad8406c80e956902": "2.0"
},
"ParentEntityId": "e169cc2b-b0dc-4ddc-a7ea-bf627745f00b",
"_links": [],
"_embedded": null
}
],
"Total": 1
}
